home *** CD-ROM | disk | FTP | other *** search
/ Workbench Design / WB Collection.iso / workbench werkzeuge / icon tools / mriconsort / mriconsort.guide (.txt) < prev    next >
Amigaguide Document  |  1996-04-07  |  13KB  |  268 lines
  1. @database MRIconSort.guide
  2. @Master mriconsort.texi
  3. @Width 72
  4. This is the AmigaGuide
  5.  file MRIconSort.guide, produced by Makeinfo-1.49 from 
  6. the input file mriconsort.texi.
  7. Copyright (C) 1993 Mark R. Rinfret, MRsoftware All Rights Reserved.
  8. Permission is granted to make and distribute verbatim copies of this
  9. manual provided the copyright notice and this permission notice are
  10. preserved on all copies.
  11. @Node Main "MRIconSort.guide"
  12. This file documents the `MRIconSort' icon sorting tool for the Amiga
  13. family of computers.
  14.  @{" Permissions " Link "Permissions"}          Your rights to use/distribute `MRIconSort'.
  15.  @{" Overview " Link "Overview"}             Preliminary information.
  16.  @{" Installing MRIconSort " Link "Installing MRIconSort"}     How to install `MRIconSort'.
  17.  @{" Using MRIconSort " Link "Using MRIconSort"}     Running the program.
  18.  @{" Things to Do " Link "Things to Do"}         Future plans.
  19.  @{" Concept Index " Link "Concept Index"}        Index of concepts.
  20. @EndNode
  21. @Node "Permissions" "MRIconSort.guide/Permissions"
  22. @Next "Overview"
  23. @Toc "Main"
  24. Permissions
  25. ***********
  26.      Copyright (C) 1993 Mark R. Rinfret, MRsoftware
  27.      All Rights Reserved.
  28. MRIconSort is freely distributable shareware.  It may be redistributed
  29. via magnetic media or electronic bulletin board systems (BBS).  It is
  30. unlawful to charge a fee for this software other than reasonable
  31. distribution/media fees.
  32. The author assumes no responsibilty for damages incurred as a result of
  33. using MRIconSort.  USE AT YOUR OWN RISK!  No warranties, either
  34. expressed or implied, are made with regard to its use on any system.
  35. Once you have tried MRIconSort and have decided to continue using it,
  36. you are requested to submit five dollars ($5.00 U.S.) to the author. 
  37. You should also provide the following information:
  38.          Your mail address
  39.          Your e-mail address(es), if any
  40.          The version of MRIconSort you are registering
  41. Send this to:
  42.          MRsoftware
  43.          348 Indian Avenue
  44.          Portsmouth, RI  02871
  45. @EndNode
  46. @Node "Overview" "MRIconSort.guide/Overview"
  47. @Next "Installing MRIconSort"
  48. @Prev "Permissions"
  49. @Toc "Main"
  50. Overview
  51. ********
  52. MRIconSort (Mark Rinfret's Icon Sort - go ahead, call it "Mister Icon
  53. Sort" :-) is a tool which will alphabetize and align your WorkBench
  54. icons, creating order where there is chaos.
  55. Though the WorkBench interface has its niceties, things can run amuck
  56. when you have drawers containing many icons. Things become especially
  57. confusing when most of those icons look the same (large groups of
  58. pictures, drawers, etc.). The same visual cues that make the WorkBench
  59. powerful for drawers containing a few icons render it useless when you
  60. have many similarly sized and shaped icons.
  61. MRIconSort scans a directory (or a full directory hierarchy) and
  62. rearranges the icons to make navigating a WorkBench window much more
  63. orderly.  You can choose to group icons by files first, directories
  64. first or mixed (no preference).  Then, icons are alphabetized and
  65. aligned from left to right.  The vertical spacing of the icons is
  66. arranged such that the tallest icon in any row determines the height of
  67. that row and all icon text sits on the same baseline, making it easy to
  68. scan all names without getting a case of the "jumpy eyeball".
  69. MRIconSort knows about icons that have been left out on the desktop (it
  70. reads the :.backdrop file) and leaves them alone. You have your choice
  71. of right "margin": you can either use the WorkBench maximum or
  72. MRIconSort will attempt to get the "snapshot" coordinates of the window
  73. associated with each drawer.
  74. MRIconSort can also be told to create default icons for files or
  75. directories which don't have icons.
  76. MRIconSort requires AmigaDOS 2.04 and up. It will run from either the
  77. Shell or the WorkBench.
  78. MRIconSort's default behavior can be customized through the definition
  79. of a preferences file named `MRIconSort.prefs' (see
  80. @{"Installing MRIconSort" Link "Installing MRIconSort"}).
  81. @EndNode
  82. @Node "Installing MRIconSort" "MRIconSort.guide/Installing MRIconSort"
  83. @Next "Using MRIconSort"
  84. @Prev "Overview"
  85. @Toc "Main"
  86. Installing MRIconSort
  87. *********************
  88. Unpacking the MRIconSort Archive
  89. ================================
  90. You most likely received MRIconSort as an Lha archive. It will unpack
  91. into its own directory hierarchy with the following command:
  92.      lha -xa x MRIconSort.lha
  93. The actual archive name may vary from `MRIconSort.lha' since it may
  94. include a version number. If the archive is unpacked correctly, a new
  95. directory will be created containing the MRIconSort program,
  96. documentation and environment variable directories.
  97. Installing the Software
  98. =======================
  99. Make the MRIconSort directory the current directory by using the `CD'
  100. command.
  101. You can install the MRIconSort program in any suitable directory which
  102. is a part of your command search path (i.e. defined by the AmigaDOS
  103. `PATH' command). For example, if you have a directory named
  104. `SYS:Tools', you could copy the MRIconSort program there with
  105.      COPY CLONE MRIconSort MRIconSort.info SYS:Tools
  106. It is assumed that you have at least one directory on your system where
  107. document files are stored (though this is not a requirement). It is
  108. quite likely that you have several documentation directories (quite
  109. likely not sharing a common hierarchy).
  110. The documentation for MRIconSort comes in three forms:
  111.    * A plain text file named `MRIconSort.doc'
  112.    * An AmigaGuide(tm) file named `MRIconSort.guide'
  113.    * A TeX `DVI' file named `MRIconSort.dvi'.
  114. Copy any or all of these to the appropriate online documentation area.
  115. Edit MRIconSort Preferences
  116. ===========================
  117. When MRIconSort starts up, it first looks for a file name
  118. `MRIconSort.prefs' in the current directory.  If this file doesn't
  119. exist, it then looks for the file `ENV:MRIconSort.prefs'. The default
  120. `MRIconSort.prefs' file is stored in the `MRIconSort' installation
  121. directory as `Env/MRIconSort.prefs'.  This file contains `MRIconSort'
  122. configuration parameters which customize `MRIconSort's' behavior to
  123. your unique requirements.  The supplied prefereces file is
  124. self-documenting.  The `MRIconSort.prefs' file is a text file organized
  125. as one directive per line with lines of comments (lines beginning with
  126. a semi-colon) interspersed with lines of directives. Here is the
  127. supplied `MRIconSort.prefs' file:
  128.      ; This is the MRIconSort configuration file (environment variable).
  129.      ; All directives are included here. Those preceded by ";" are ignored.
  130.      ; To activate any directive, just edit this file to remove the
  131.      ; leading semi-colon from that line.
  132.      ;
  133.      ; All - Process all levels (recursive directory scan).
  134.      ;All
  135.      ;
  136.      ; FilesFirst    - Place all file icons before directory icons.
  137.      FilesFirst
  138.      ;
  139.      ; DirsFirst     - Place all directory icons before file icons.
  140.      ;DIRSFIRST
  141.      ;
  142.      ; Mixed         - Mix file and directory icons on the same line.
  143.      ;Mixed
  144.      ;
  145.      ; XSpace = <number> - Set horizontal spacing between icons (default = 8).
  146.      XSpace = 8
  147.      ;
  148.      ; YSpace = <number> - Set vertical spacing between icons (default = 2).
  149.      YSpace = 2
  150.      ;
  151.      ; MaxWidth -    - Use the maximum WorkBench screen width.
  152.      ;                 (If absent, use icon's window snapshot.)
  153.      ;MaxWidth
  154. Once these changes are made, copy the environment variable directory to
  155. both the ENV: and ENVARC: directories:
  156.      COPY CLONE ALL Env ENV:
  157.      COPY CLONE ALL Env ENVARC:
  158. If you are make changes to your global MRIconSort Preferences, remember
  159. to copy the ENV:MRIconSort.prefs file to ENVARC:. Otherwise, your
  160. changes will be lost the next time you reboot your system.
  161. @EndNode
  162. @Node "Using MRIconSort" "MRIconSort.guide/Using MRIconSort"
  163. @Next "Things to Do"
  164. @Prev "Installing MRIconSort"
  165. @Toc "Main"
  166. Using MRIconSort
  167. ****************
  168. MRIconSort can be invoked from the WorkBench or the Shell. There are
  169. distinct differences in its behavior under each environment.
  170.  @{" Shell Operation " Link "Shell Operation"}      Running MRIconSort from the Shell
  171.  @{" WorkBench Operation " Link "WorkBench Operation"}  Running MRIconSort from the WorkBench
  172. @EndNode
  173. @Node "Shell Operation" "MRIconSort.guide/Shell Operation"
  174. @Next "WorkBench Operation"
  175. @Prev "Using MRIconSort"
  176. @Toc "Using MRIconSort"
  177. Shell Operation
  178. ***************
  179. When run from the Shell, `MRIconSort' attempts to read the preferences
  180. file, `MRIconSort.prefs', first from the current directory and, if no
  181. file is found there, from `ENV:MRIconSort.prefs'.  Any command line
  182. parameters then override the preferences settings.  The basic format of
  183. the command line is:
  184.      MRIconSort <directory_name> <options>
  185. The MRIconSort command template is:
  186.      Dir/A,DirsFirst/S,FilesFirst/S,Mixed/S,Create/S,All/S,MaxWidth/S,
  187.      XSpace/K/N,YSpace/K/N
  188. MRIconSort's parameters are defined as follows:
  189.    * Dir
  190.      This is the name of the directory whose icon's are to be
  191.      sorted/created.
  192.    * DirsFirst
  193.      This is a switch which indicates that directory icons are to
  194.      appear before file icons. The default is FilesFirst.
  195.    * FilesFirst
  196.      This is a switch which indicates that file icons are to appear
  197.      before directory icons. This is the default behavior.
  198.    * Mixed
  199.      This is a switch which indictes that no preference is to be given
  200.      to the order of file and directory icons (i.e. they will be mixed).
  201.    * Create
  202.      This is a switch which turns on icon creation for any files or
  203.      directories not having an icon.
  204.    * All
  205.      This switch instructs `MRIconSort' to sort all levels (descend the
  206.      directory tree).
  207.    * MaxWidth
  208.      Normally, `MRIconSort' will attempt to obtain the WorkBench window
  209.      dimension "snapshot" for the drawer being organized and use the
  210.      window width as the right-hand margin for each row of icons.
  211.      However, if this switch is specified, `MRIconSort' will use the
  212.      current WorkBench screen width.
  213.    * XSpace = <pixels>
  214.      This parameter specifies the horizontal spacing factor.
  215.      `MRIconSort' defaults to 8 pixels.
  216.    * XYspace = <pixels>
  217.      This parameter specifies the vertical spacing factor. MRIconSort
  218.      defaults to 2 pixels.
  219. @EndNode
  220. @Node "WorkBench Operation" "MRIconSort.guide/WorkBench Operation"
  221. @Prev "Shell Operation"
  222. @Toc "Using MRIconSort"
  223. WorkBench Operation
  224. *******************
  225. When `MRIconSort' is invoked from the WorkBench, it will first attempt
  226. to read its preferences settings from the `ENV:MRIconSort.prefs' file
  227. and then will override these settings with any ToolType entries it may
  228. find in its tool icon. The `MRIconSort' ToolType entries are identical
  229. in name and syntax to the command line template definitions (see
  230. @{"Shell Operation" Link "Shell Operation"}) with the exception of the `Dir' parameter which cannot
  231. be specified as a ToolType.
  232. Multiple directories can be processed when running from the WorkBench.
  233. Simply shift-select the icons for the drawers you want to process.
  234. @EndNode
  235. @Node "Things to Do" "MRIconSort.guide/Things to Do"
  236. @Next "Concept Index"
  237. @Prev "Using MRIconSort"
  238. @Toc "Main"
  239. Things to Do
  240. ************
  241. I intend to evolve and improve `MRIconSort' over time.  Your input will
  242. be greatly appreciated.  Some of the changes planned (not necessarily
  243. in any particular order) are:
  244.    * Grid Snap
  245.      This option will force icons to snap to an invisible grid.
  246.    * Window Dimension Setting
  247.      This option will reset all drawer window dimensions to a
  248.      user-specified value.
  249.    * Icon Creation Exclusion List
  250.      This feature will inhibit icon creation for filenames matching a
  251.      list of patterns (e.g.  *.c, *.o, etc.).
  252. @EndNode
  253. @Node "Concept Index" "MRIconSort.guide/Concept Index"
  254. @Prev "Things to Do"
  255. @Toc "Main"
  256. Concept Index
  257. *************
  258.  @{" Environment Variables " Link "Overview"}                Overview
  259.  @{" Installation " Link "Installing MRIconSort"}                         Installing MRIconSort
  260.  @{" MRIconSort Preferences " Link "Installing MRIconSort"}               Installing MRIconSort
  261.  @{" Overview " Link "Overview"}                             Overview
  262.  @{" Permissions " Link "Permissions"}                          Permissions
  263.  @{" Plans for the Future " Link "Things to Do"}                 Things to Do
  264.  @{" Shell Operation " Link "Shell Operation"}                      Shell Operation
  265.  @{" Using MRIconSort " Link "Using MRIconSort"}                     Using MRIconSort
  266.  @{" WorkBench Operation " Link "WorkBench Operation"}                  WorkBench Operation
  267. @EndNode
  268.